home *** CD-ROM | disk | FTP | other *** search
/ Language/OS - Multiplatform Resource Library / LANGUAGE OS.iso / ptolemy / pt-041do.lha / ptolemy / doc / README < prev    next >
Text File  |  1992-12-17  |  2KB  |  55 lines
  1. @(#)README    1.4 12/17/92
  2.  
  3. To print out the entire manual, make sure your PRINTER environment
  4. variable is set.  If it isn't (if echo $PRINTER says the variable is
  5. undefined) you can type (for csh)
  6.  
  7.     setenv PRINTER lw
  8. where "lw" is replaced with the name of your printer.
  9. Then
  10.     % cd ~ptolemy/doc
  11.     % make print
  12.  
  13. You no longer need write permission in the ptolemy directories to print
  14. the manual.  You do need to be able to write to your OWN home directory --
  15. files named Almagest.main and Almagest.index are created there.
  16.  
  17. You no longer need to have the "ditroff" program to print out the manual.
  18. It is now possible to print the manual using the "groff" program from the
  19. Free Software Foundation.  If you wish to use groff, follow the 
  20. instructions in the $PTOLEMY/doc/main/documents/overall file.
  21.  
  22. The manual currently consists of the following
  23. sections:
  24.     sect 1: general Ptolemy documentation
  25.     sects 2-N: Domain-specific documentation
  26.  
  27. To print only sect 1, 
  28.     % cd ~ptolemy/doc/main
  29.     % make print
  30.  
  31. To print only certain pages of sect 1, for example, pages 48 through the end,
  32.     % make OPTIONS=-o48- print
  33. (note that if you print only certain pages, you may generate an incomplete
  34. index file.  To avoid this, be sure your page range includes the last page
  35. of the document. For example, if you want pages 10-12, and page 55 is the
  36. last one, then use the command:
  37.     % make OPTIONS=-o10-12,55- print
  38.  
  39. To print a subsection of sect 1, such as the pigi chapter,
  40.     % cd ~ptolemy/doc/main/pigi
  41.     % make print
  42.  
  43. To print an updated index after printing a new subsection
  44.     % cd ~ptolemy/doc
  45.     % make prindex
  46.  
  47. To print only a domain-specific document, for example sdf,
  48.     % cd ~ptolemy/src/domains/sdf/doc
  49.     % make print
  50.  
  51. To preview a section, change to its directory and type "make preview".
  52.  
  53. A separate manual that describes the kernel at a programmer's level is
  54. in the subdirectory kernelManual.
  55.